'\" -*- coding: us-ascii -*-
.if \n(.g .ds T< \\FC
.if \n(.g .ds T> \\F[\n[.fam]]
.de URL
\\$2 \(la\\$1\(ra\\$3
..
.if \n(.g .mso www.tmac
.TH omod 8 2009-02-27 Daemons ""
.SH NAME
omod \- a commet based ajax messaging server
.SH SYNOPSIS
'nh
.fi
.ad l
\fBomod\fR \kx
.if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
'in \n(.iu+\nxu
[\fB-4\fR] [\fB-6\fR] [\fB-c\fR \fIfile\fR | \fB--config=\fRfile] [\fB-d | --debug\fR] [\fB-u\fR \fIuser\fR | \fB--user=\fRuser] [\fB-g\fR \fIgroup\fR | \fB--group=\fRgroup]
'in \n(.iu-\nxu
.ad b
'hy
'nh
.fi
.ad l
\fBomod\fR \kx
.if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
'in \n(.iu+\nxu
{
\fB-h | --help\fR
}
'in \n(.iu-\nxu
.ad b
'hy
'nh
.fi
.ad l
\fBomod\fR \kx
.if (\nx>(\n(.l/2)) .nr x (\n(.l/5)
'in \n(.iu+\nxu
{
\fB-v | --version\fR
}
'in \n(.iu-\nxu
.ad b
'hy
.SH DESCRIPTION
\fBomod\fR is a stand alone daemon which serves two primary functions:
It keeps an active web request open from each web browser within its control, and
it forwards asynchronous messages from authorized servers back to those web
clients in \fIrealtime\fR.
.SH OPTIONS
.TP 
\*(T<\fB\-4\fR\*(T>
Listen on IPv4 addresses only.
.TP 
\*(T<\fB\-6\fR\*(T>
Listen on IPv6 addresses only.
.TP 
\*(T<\fB\-c\fR\*(T> \fIfile\fR, \*(T<\fB\-\-config=\fR\*(T>\fIfile\fR
Use the specified configuration file. If this option is not specified, the compiled in default location will be used.
.TP 
\*(T<\fB\-d\fR\*(T>, \*(T<\fB\-\-debug\fR\*(T>
Do not detach from controlling terminal. If this option is \fInot\fR specified, \fBomod\fR will detach from its controlling terminal and fork into daemon mode.
.TP 
\*(T<\fB\-h\fR\*(T>, \*(T<\fB\-\-help\fR\*(T>
Print helpful output and exit.
.TP 
\*(T<\fB\-v\fR\*(T>, \*(T<\fB\-\-version\fR\*(T>
Print version information and exit.
.TP 
\*(T<\fB\-u\fR\*(T> \fIuser\fR, \*(T<\fB\-\-user=\fR\*(T>\fIuser\fR
\fBomod\fR will run with the specified user name or user id.
.TP 
\*(T<\fB\-g\fR\*(T> \fIgroup\fR, \*(T<\fB\-\-group=\fR\*(T>\fIgroup\fR
\fBomod\fR will run with the specified group name or group id.
.SH FILES
The default configuration file is located at \*(T<\fI/usr/local/etc/omod.conf\fR\*(T>, but
can be changed at compile time or run time.
.SH MAINTAINER
\fBomod\fR and this associated documentation is maintained by
Dan White
<\*(T<whitehse@gmail.com\*(T>>.
.SH THANKS
To Brad Vernon, for help with the design of \fBomod\fR and with testing.
.SH COPYRIGHT
Copyright 2009 Dan White. \fBomod\fR is free software: you can
redistribute it and/or modify it under the terms of the GNU General Public License
as published by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
.PP
\fBomod\fR is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with Foobar. If not, see http://www.gnu.org/licenses/.
.SH BUGS
.SH HISTORY
Version 0.1 released on xxxx-xx-xx. Initial release.
.SH "SEE ALSO"
\fBomod.conf\fR(5), \fBomoctl\fR(8).
